<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Macros</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__ipc__pipe__macros.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Macros<div class="ingroups"><a class="el" href="group__group__ipc.html">IPC          (Inter Process Communication)</a> &raquo; <a class="el" href="group__group__ipc__pipe.html">IPC pipes layer (IPC_PIPE)</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Macro definitions are used in the driver. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaef308bb8d8b51edcbb6efbec8a6eaf87"><td class="memItemLeft" align="right" valign="top"><a id="gaef308bb8d8b51edcbb6efbec8a6eaf87"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#gaef308bb8d8b51edcbb6efbec8a6eaf87">CY_IPC_PIPE_CFG_IMASK_Pos</a>&#160;&#160;&#160;(16UL)</td></tr>
<tr class="memdesc:gaef308bb8d8b51edcbb6efbec8a6eaf87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupts shift value for endpoint address. <br /></td></tr>
<tr class="separator:gaef308bb8d8b51edcbb6efbec8a6eaf87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae22d12f3bd5c47a1f52780cb0619c98"><td class="memItemLeft" align="right" valign="top"><a id="gaae22d12f3bd5c47a1f52780cb0619c98"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#gaae22d12f3bd5c47a1f52780cb0619c98">CY_IPC_PIPE_CFG_IMASK_Msk</a>&#160;&#160;&#160;(0xFFFF0000UL)</td></tr>
<tr class="memdesc:gaae22d12f3bd5c47a1f52780cb0619c98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupts mask for endpoint address. <br /></td></tr>
<tr class="separator:gaae22d12f3bd5c47a1f52780cb0619c98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga88b97a1b463ca4f1c7c636e1a0103c45"><td class="memItemLeft" align="right" valign="top"><a id="ga88b97a1b463ca4f1c7c636e1a0103c45"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga88b97a1b463ca4f1c7c636e1a0103c45">CY_IPC_PIPE_CFG_INTR_Pos</a>&#160;&#160;&#160;(8UL)</td></tr>
<tr class="memdesc:ga88b97a1b463ca4f1c7c636e1a0103c45"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPC Interrupt shift value for endpoint address. <br /></td></tr>
<tr class="separator:ga88b97a1b463ca4f1c7c636e1a0103c45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53010c9773541aba0dceb53aa513f5c5"><td class="memItemLeft" align="right" valign="top"><a id="ga53010c9773541aba0dceb53aa513f5c5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga53010c9773541aba0dceb53aa513f5c5">CY_IPC_PIPE_CFG_INTR_Msk</a>&#160;&#160;&#160;(0x0000FF00UL)</td></tr>
<tr class="memdesc:ga53010c9773541aba0dceb53aa513f5c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPC Interrupt mask for endpoint address. <br /></td></tr>
<tr class="separator:ga53010c9773541aba0dceb53aa513f5c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4bd72f8ac7b4d27b1e55498666316597"><td class="memItemLeft" align="right" valign="top"><a id="ga4bd72f8ac7b4d27b1e55498666316597"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga4bd72f8ac7b4d27b1e55498666316597">CY_IPC_PIPE_CFG_CHAN_Pos</a>&#160;&#160;&#160;(0UL)</td></tr>
<tr class="memdesc:ga4bd72f8ac7b4d27b1e55498666316597"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPC Channel shift value for endpoint address. <br /></td></tr>
<tr class="separator:ga4bd72f8ac7b4d27b1e55498666316597"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3401ac0533dd69ee7026a187708646e7"><td class="memItemLeft" align="right" valign="top"><a id="ga3401ac0533dd69ee7026a187708646e7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga3401ac0533dd69ee7026a187708646e7">CY_IPC_PIPE_CFG_CHAN_Msk</a>&#160;&#160;&#160;(0x000000FFUL)</td></tr>
<tr class="memdesc:ga3401ac0533dd69ee7026a187708646e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">IPC Channel mask for endpoint address. <br /></td></tr>
<tr class="separator:ga3401ac0533dd69ee7026a187708646e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71c92c61208e90739319153801decd82"><td class="memItemLeft" align="right" valign="top"><a id="ga71c92c61208e90739319153801decd82"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga71c92c61208e90739319153801decd82">CY_IPC_PIPE_MSG_CLIENT_Msk</a>&#160;&#160;&#160;(0x000000FFUL)</td></tr>
<tr class="memdesc:ga71c92c61208e90739319153801decd82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Client mask for first word of Pipe message. <br /></td></tr>
<tr class="separator:ga71c92c61208e90739319153801decd82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga80c3cc73a998e8ee5692de60948ed066"><td class="memItemLeft" align="right" valign="top"><a id="ga80c3cc73a998e8ee5692de60948ed066"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga80c3cc73a998e8ee5692de60948ed066">CY_IPC_PIPE_MSG_CLIENT_Pos</a>&#160;&#160;&#160;(0UL)</td></tr>
<tr class="memdesc:ga80c3cc73a998e8ee5692de60948ed066"><td class="mdescLeft">&#160;</td><td class="mdescRight">Client shift for first word of Pipe message. <br /></td></tr>
<tr class="separator:ga80c3cc73a998e8ee5692de60948ed066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3b55c71570474e201246a85e017df70"><td class="memItemLeft" align="right" valign="top"><a id="gae3b55c71570474e201246a85e017df70"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#gae3b55c71570474e201246a85e017df70">CY_IPC_PIPE_MSG_USR_Msk</a>&#160;&#160;&#160;(0x0000FF00UL)</td></tr>
<tr class="memdesc:gae3b55c71570474e201246a85e017df70"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data mask for first word of Pipe message. <br /></td></tr>
<tr class="separator:gae3b55c71570474e201246a85e017df70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3404ffd6cd31868d865703a1db5cf48b"><td class="memItemLeft" align="right" valign="top"><a id="ga3404ffd6cd31868d865703a1db5cf48b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga3404ffd6cd31868d865703a1db5cf48b">CY_IPC_PIPE_MSG_USR_Pos</a>&#160;&#160;&#160;(8UL)</td></tr>
<tr class="memdesc:ga3404ffd6cd31868d865703a1db5cf48b"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data shift for first word of Pipe message. <br /></td></tr>
<tr class="separator:ga3404ffd6cd31868d865703a1db5cf48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44df0c7be6aaed9314785ee83f4bca07"><td class="memItemLeft" align="right" valign="top"><a id="ga44df0c7be6aaed9314785ee83f4bca07"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga44df0c7be6aaed9314785ee83f4bca07">CY_IPC_PIPE_MSG_RELEASE_Msk</a>&#160;&#160;&#160;(0xFFFF0000UL)</td></tr>
<tr class="memdesc:ga44df0c7be6aaed9314785ee83f4bca07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mask for message release mask. <br /></td></tr>
<tr class="separator:ga44df0c7be6aaed9314785ee83f4bca07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a3de20e14f0dc41bad5a02a7ae7d775"><td class="memItemLeft" align="right" valign="top"><a id="ga1a3de20e14f0dc41bad5a02a7ae7d775"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga1a3de20e14f0dc41bad5a02a7ae7d775">CY_IPC_PIPE_MSG_RELEASE_Pos</a>&#160;&#160;&#160;(16UL)</td></tr>
<tr class="memdesc:ga1a3de20e14f0dc41bad5a02a7ae7d775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift require to line up mask to LSB. <br /></td></tr>
<tr class="separator:ga1a3de20e14f0dc41bad5a02a7ae7d775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga344b1c9981dc7cb82bd85b9520694662"><td class="memItemLeft" align="right" valign="top"><a id="ga344b1c9981dc7cb82bd85b9520694662"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga344b1c9981dc7cb82bd85b9520694662">CY_IPC_PIPE_ENDPOINT_BUSY</a>&#160;&#160;&#160;(1UL)</td></tr>
<tr class="memdesc:ga344b1c9981dc7cb82bd85b9520694662"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use to set the busy flag when waiting for a release interrupt. <br /></td></tr>
<tr class="separator:ga344b1c9981dc7cb82bd85b9520694662"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd3725262cdc5b55cd44a366061ebd0b"><td class="memItemLeft" align="right" valign="top"><a id="gacd3725262cdc5b55cd44a366061ebd0b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#gacd3725262cdc5b55cd44a366061ebd0b">CY_IPC_PIPE_ENDPOINT_NOTBUSY</a>&#160;&#160;&#160;(0UL)</td></tr>
<tr class="memdesc:gacd3725262cdc5b55cd44a366061ebd0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Denotes that a release interrupt is not pending. <br /></td></tr>
<tr class="separator:gacd3725262cdc5b55cd44a366061ebd0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25a61235b9cb877846b5fd4de336787c"><td class="memItemLeft" align="right" valign="top"><a id="ga25a61235b9cb877846b5fd4de336787c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga25a61235b9cb877846b5fd4de336787c">CY_IPC_PIPE_RTN</a>&#160;&#160;&#160;(0x0200UL)</td></tr>
<tr class="memdesc:ga25a61235b9cb877846b5fd4de336787c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Software PDL driver ID for IPC pipe functions. <br /></td></tr>
<tr class="separator:ga25a61235b9cb877846b5fd4de336787c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafe946c71c4d8dacd1e49ad610d4e0d72"><td class="memItemLeft" align="right" valign="top"><a id="gafe946c71c4d8dacd1e49ad610d4e0d72"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#gafe946c71c4d8dacd1e49ad610d4e0d72">CY_IPC_PIPE_ID_INFO</a>&#160;&#160;&#160;(uint32_t)( <a class="el" href="group__group__ipc__macros.html#gaca94e95050e9f6ad972c8d9fe3de70d0">CY_IPC_ID_INFO</a>    | <a class="el" href="group__group__ipc__pipe__macros.html#ga25a61235b9cb877846b5fd4de336787c">CY_IPC_PIPE_RTN</a>)</td></tr>
<tr class="memdesc:gafe946c71c4d8dacd1e49ad610d4e0d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return prefix for IPC pipe function status codes. <br /></td></tr>
<tr class="separator:gafe946c71c4d8dacd1e49ad610d4e0d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48131a54fc5a64a3aec1ac9f6dc4286c"><td class="memItemLeft" align="right" valign="top"><a id="ga48131a54fc5a64a3aec1ac9f6dc4286c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga48131a54fc5a64a3aec1ac9f6dc4286c">CY_IPC_PIPE_ID_WARNING</a>&#160;&#160;&#160;(uint32_t)( <a class="el" href="group__group__ipc__macros.html#ga3dd639f2edc5ca00b5547a32d3ad57de">CY_IPC_ID_WARNING</a> | <a class="el" href="group__group__ipc__pipe__macros.html#ga25a61235b9cb877846b5fd4de336787c">CY_IPC_PIPE_RTN</a>)</td></tr>
<tr class="memdesc:ga48131a54fc5a64a3aec1ac9f6dc4286c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return prefix for IPC pipe function warning return values. <br /></td></tr>
<tr class="separator:ga48131a54fc5a64a3aec1ac9f6dc4286c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8a2de63afa3decd68bdf4ba30082f9a1"><td class="memItemLeft" align="right" valign="top"><a id="ga8a2de63afa3decd68bdf4ba30082f9a1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__ipc__pipe__macros.html#ga8a2de63afa3decd68bdf4ba30082f9a1">CY_IPC_PIPE_ID_ERROR</a>&#160;&#160;&#160;(uint32_t)( <a class="el" href="group__group__ipc__macros.html#ga3f7a70ed9127495bf0fa4ba8135c49ba">CY_IPC_ID_ERROR</a>   | <a class="el" href="group__group__ipc__pipe__macros.html#ga25a61235b9cb877846b5fd4de336787c">CY_IPC_PIPE_RTN</a>)</td></tr>
<tr class="memdesc:ga8a2de63afa3decd68bdf4ba30082f9a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return prefix for IPC pipe function error return values. <br /></td></tr>
<tr class="separator:ga8a2de63afa3decd68bdf4ba30082f9a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
